home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 85 / CD Actual 85 Febrero 2004.iso / Experto / Apache / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F252571_mod_so.html.en < prev    next >
Encoding:
Extensible Markup Language  |  2003-05-29  |  10.1 KB  |  188 lines
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>mod_so - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body>
  14. <div id="page-header">
  15. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16. <p class="apache">Apache HTTP Server Version 2.0</p>
  17. <img alt="" src="../images/feather.gif" /></div>
  18. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  19. <div id="path">
  20. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div>
  21. <div id="page-content">
  22. <div id="preamble"><h1>Apache Module mod_so</h1>
  23. <div class="toplang">
  24. <p><span>Available Languages: </span><a href="../en/mod/mod_so.html" title="English"> en </a> |
  25. <a href="../ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
  26. </div>
  27. <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Loading of executable code and
  28. modules into the server at start-up or restart time</td></tr>
  29. <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  30. <tr><th><a href="module-dict.html#ModuleIdentifier">ModuleáIdentifier:</a></th><td>so_module</td></tr>
  31. <tr><th><a href="module-dict.html#SourceFile">SourceáFile:</a></th><td>mod_so.c</td></tr>
  32. <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>This is a Base module (always included) on 
  33. Windows</td></tr></table>
  34. <h3>Summary</h3>
  35.  
  36.  
  37.     <p>On selected operating systems this module can be used to
  38.     load modules into Apache at runtime via the <a href="../dso.html">Dynamic Shared Object</a> (DSO) mechanism,
  39.     rather than requiring a recompilation.</p>
  40.  
  41.     <p>On Unix, the loaded code typically comes from shared object
  42.     files (usually with <code>.so</code> extension), on Windows
  43.     this may either the <code>.so</code> or <code>.dll</code>
  44.     extension.</p>
  45.  
  46.     <div class="warning"><h3>Warning</h3>
  47.     <p>Apache 1.3 modules cannot be directly used
  48.     with Apache 2.0 - the module must be modified to dynamically
  49.     load or compile into Apache 2.0.</p>
  50.     </div>
  51. </div>
  52. <div id="quickview"><h3 class="directives">Directives</h3>
  53. <ul id="toc">
  54. <li><img alt="" src="../images/down.gif" /> <a href="#loadfile">LoadFile</a></li>
  55. <li><img alt="" src="../images/down.gif" /> <a href="#loadmodule">LoadModule</a></li>
  56. </ul>
  57. <h3>Topics</h3>
  58. <ul id="topics">
  59. <li><img alt="" src="../images/down.gif" /> <a href="#windows">Creating Loadable Modules for Windows</a></li>
  60. </ul></div>
  61. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  62. <div class="section">
  63. <h2><a name="windows" id="windows">Creating Loadable Modules for Windows</a></h2>
  64.  
  65.     <div class="note"><h3>Note</h3>
  66.     <p>The module name format changed for Windows
  67.     with Apache 1.3.15 and 2.0 - the modules are now named as
  68.     mod_foo.so</p>
  69.  
  70.     <p>While mod_so still loads modules with
  71.     ApacheModuleFoo.dll names, the new naming convention is
  72.     preferred; if you are converting your loadable module for 2.0,
  73.     please fix the name to this 2.0 convention.</p></div>
  74.  
  75.     <p>The Apache module API is unchanged between the Unix and
  76.     Windows versions. Many modules will run on Windows with no or
  77.     little change from Unix, although others rely on aspects of the
  78.     Unix architecture which are not present in Windows, and will
  79.     not work.</p>
  80.  
  81.     <p>When a module does work, it can be added to the server in
  82.     one of two ways. As with Unix, it can be compiled into the
  83.     server. Because Apache for Windows does not have the
  84.     <code>Configure</code> program of Apache for Unix, the module's
  85.     source file must be added to the ApacheCore project file, and
  86.     its symbols must be added to the
  87.     <code>os\win32\modules.c</code> file.</p>
  88.  
  89.     <p>The second way is to compile the module as a DLL, a shared
  90.     library that can be loaded into the server at runtime, using
  91.     the <code><code class="directive">LoadModule</code></code>
  92.     directive. These module DLLs can be distributed and run on any
  93.     Apache for Windows installation, without recompilation of the
  94.     server.</p>
  95.  
  96.     <p>To create a module DLL, a small change is necessary to the
  97.     module's source file: The module record must be exported from
  98.     the DLL (which will be created later; see below). To do this,
  99.     add the <code>AP_MODULE_DECLARE_DATA</code> (defined in the
  100.     Apache header files) to your module's module record definition.
  101.     For example, if your module has:</p>
  102.  
  103. <div class="example"><p><code>
  104.     module foo_module;
  105. </code></p></div>
  106.  
  107.     <p>Replace the above with:</p>
  108. <div class="example"><p><code>
  109.     module AP_MODULE_DECLARE_DATA foo_module;
  110. </code></p></div>
  111.  
  112.     <p>Note that this will only be activated on Windows, so the
  113.     module can continue to be used, unchanged, with Unix if needed.
  114.     Also, if you are familiar with <code>.DEF</code> files, you can
  115.     export the module record with that method instead.</p>
  116.  
  117.     <p>Now, create a DLL containing your module. You will need to
  118.     link this against the libhttpd.lib export library that is
  119.     created when the libhttpd.dll shared library is compiled. You
  120.     may also have to change the compiler settings to ensure that
  121.     the Apache header files are correctly located. You can find
  122.     this library in your server root's modules directory. It is
  123.     best to grab an existing module .dsp file from the tree to
  124.     assure the build environment is configured correctly, or
  125.     alternately compare the compiler and link options to your
  126.     .dsp.</p>
  127.  
  128.     <p>This should create a DLL version of your module. Now simply
  129.     place it in the <code>modules</code> directory of your server
  130.     root, and use the <code class="directive">LoadModule</code>
  131.     directive to load it.</p>
  132.  
  133. </div>
  134. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  135. <div class="directive-section"><h2><a name="LoadFile" id="LoadFile">LoadFile</a> <a name="loadfile" id="loadfile">Directive</a></h2>
  136. <table class="directive">
  137. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Link in the named object file or library</td></tr>
  138. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadFile <em>filename</em> [<em>filename</em>] ...</code></td></tr>
  139. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  140. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  141. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr>
  142. </table>
  143.  
  144.     <p>The LoadFile directive links in the named object files or
  145.     libraries when the server is started or restarted; this is used
  146.     to load additional code which may be required for some module
  147.     to work. <em>Filename</em> is either an absolute path or
  148.     relative to <a href="core.html#serverroot">ServerRoot</a>.</p>
  149.  
  150.     <p>For example:</p>
  151.  
  152.     <div class="example"><p><code>LoadFile libexec/libxmlparse.so</code></p></div>
  153.  
  154.  
  155. </div>
  156. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  157. <div class="directive-section"><h2><a name="LoadModule" id="LoadModule">LoadModule</a> <a name="loadmodule" id="loadmodule">Directive</a></h2>
  158. <table class="directive">
  159. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Links in the object file or library, and adds to the list
  160. of active modules</td></tr>
  161. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadModule <em>module filename</em></code></td></tr>
  162. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  163. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  164. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr>
  165. </table>
  166.     <p>The LoadModule directive links in the object file or library
  167.     <em>filename</em> and adds the module structure named
  168.     <em>module</em> to the list of active modules. <em>Module</em>
  169.     is the name of the external variable of type
  170.     <code>module</code> in the file, and is listed as the <a href="module-dict.html#ModuleIdentifier">Module Identifier</a>
  171.     in the module documentation. Example:</p>
  172.  
  173.     <div class="example"><p><code>
  174.       LoadModule status_module modules/mod_status.so
  175.     </code></p></div>
  176.  
  177.     <p>loads the named module from the modules subdirectory of the
  178.     ServerRoot.</p>
  179.  
  180. </div>
  181. </div>
  182. <div class="bottomlang">
  183. <p><span>Available Languages: </span><a href="../en/mod/mod_so.html" title="English"> en </a> |
  184. <a href="../ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
  185. </div><div id="footer">
  186. <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
  187. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  188. </body></html>